Update dependency ava to v6 #103
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.25.0->6.4.1Release Notes
avajs/ava (ava)
v6.4.1Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v6.4.0...v6.4.1
v6.4.0Compare Source
What's Changed
Interactive watch mode filters
@mmulet did fantastic work to spearhead interactive watch mode filters. You can now filter test files by glob patterns, and tests by matching their titles. It's just like you already could from the CLI itself, but now without exiting AVA 🚀 #3372
As part of this work we've removed the "sticky"
.only()behavior #3381Examples
We've been remiss in merging #3335 which updates the examples to use AVA 6. It's done now, examples are up to date and it's all due to @tommy-mitchell 👏
New Contributors
Full Changelog: avajs/ava@v6.3.0...v6.4.0
v6.3.0Compare Source
What's Changed
npm auditwarnings by @novemberborn in #3377New Contributors
Full Changelog: avajs/ava@v6.2.0...v6.3.0
v6.2.0Compare Source
What's Changed
filterNodeArgumentsForWorkerThreadsoption in #3336New Contributors
Full Changelog: avajs/ava@v6.1.3...v6.2.0
v6.1.3Compare Source
What's Changed
serialconfiguration option by @turadg in #3321New Contributors
Full Changelog: avajs/ava@v6.1.2...v6.1.3
v6.1.2Compare Source
What's Changed
any: trueby @gibson042 in #3313Full Changelog: avajs/ava@v6.1.1...v6.1.2
v6.1.1Compare Source
What's Changed
Full Changelog: avajs/ava@v6.1.0...v6.1.1
v6.1.0Compare Source
What's Changed
Implement
registerCompletionHandler()by @novemberborn in #3283AVA 6 expects test code to clean up gracefully when the tests are complete, allowing the test environment (worker thread or child process) to exit. If this does not happen, AVA will report a timeout. You can use
registerCompletionHandler()to perform any other clean up (or indeed exit the process) after AVA has completed the test execution. See the description here.Fix potential bug with watch mode when no failed test files are written by @novemberborn in #3287
Fix
ava/internalESM type module by @codetheweb in #3292Full Changelog: avajs/ava@v6.0.1...v6.1.0
v6.0.1Compare Source
What's Changed
Full Changelog: avajs/ava@v6.0.0...v6.0.1
v6.0.0Compare Source
Breaking Changes
AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. #3251 #3216
When tests finish, worker threads or child processes are no longer exited through
proces.exit(). If your test file does not exit on its own, the test run will time out. #3260Changes to watch mode #3218:
ava.config.*orpackage.jsonconfiguration.ignoredByWatcherconfiguration has moved to thewatchModeobject, under theignoreChangeskey.fs.watch()in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are caveats to keep in mind.Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. #3246
Only native errors are now considered errors by the
t.throws()andt.throwsAsync()assertions.Object.create(Error.prototype)is not a native error. #3229Changes to modules loaded through the
requireconfiguration #3184:@ava/typescriptif necessary.Improvements
Rewritten watcher
The watcher has been rewritten. It’s now built on
fs.watch()in recursive mode.@vercel/nftis used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM.Integration with
@ava/typescripthas been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests.The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key.
See #3218 and #3257.
Failed assertions now throw
Assertions now throw a
TestFailureerror when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, uset.try()instead.All assertions except for
t.throws()andt.throwsAsync()now returntruewhen they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard.Committing a failed
t.try()result now also throws.See #3246.
t.throws()andt.throwsAsync()can now expect any errorBy default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting
any: truein the expectation object:See #3245 by @adiSuper94.
The
requireconfiguration is now more powerfulIt now loads ES modules.
Local files are loaded through
@ava/typescriptif necessary, so you can also write these in TypeScript.If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a [structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)).
See #3184 by @sculpt0r.
Other changes worth noting
t.timeout.clear()to restore a previoust.timeout(). #3221New Contributors
Full Changelog: avajs/ava@v5.3.1...v6.0.0
v5.3.1Compare Source
What's Changed
t.like()to support Symbol keys and ignore non-enumerable properties by @gibson042 in #3209t.like()by @novemberborn in #3212Full Changelog: avajs/ava@v5.3.0...v5.3.1
v5.3.0Compare Source
What's Changed
t.like()assertions by @tommy-mitchell in #3185expectandassert) and use their formatting by @Irvenae in #3187New Contributors
Full Changelog: avajs/ava@v5.2.0...v5.3.0
v5.2.0Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v5.1.1...v5.2.0
v5.1.1Compare Source
What's Changed
Full Changelog: avajs/ava@v5.1.0...v5.1.1
v5.1.0Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v5.0.1...v5.1.0
v5.0.1Compare Source
Despite the major version bump this is a relatively minor release. Node.js 12 is no longer supported. The type definitions are now distributed to be compatible with TypeScript 4.7 or newer.
npm install --save-dev avaBreaking Changes
Improvements
process.exit()called from tests by @gibson042 in #3080os.cpus()returning an empty array on unsupported platforms by @catink123 in #3095New Contributors
Full Changelog: avajs/ava@v4.3.3...v5.0.1
v5.0.0Compare Source
Despite the major version bump this is a relatively minor release. Node.js 12 is no longer supported. The type definitions are now distributed to be compatible with TypeScript 4.7 or newer.
It's available as a pre-release under the
nexttag for the next few weeks:npm install --save-dev ava@nextBreaking Changes
Improvements
process.exit()called from tests by @gibson042 in #3080os.cpus()returning an empty array on unsupported platforms by @catink123 in #3095New Contributors
Full Changelog: avajs/ava@v4.3.3...v5.0.0
v4.3.3Compare Source
Add compatibility with Node.js 18.8, thanks @Brooooooklyn #3091.
Full Changelog: avajs/ava@v4.3.1...v4.3.3
v4.3.2Compare Source
v4.3.1Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v4.3.0...v4.3.1
v4.3.0Compare Source
What's Changed
throwsandthrowsAsyncassertions now take a function to test error messages, by @il3ven in #2995t.log()messages, by @il3ven in #3013Full Changelog: avajs/ava@v4.2.0...v4.3.0
v4.2.0Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v4.1.0...v4.2.0
v4.1.0Compare Source
New features
sortTestFiles()inava.config.jsfiles by @erezrokah in #2968ava.config.jsonfiles are encountered by @razor-x in #2962deepEqualassertion by @RebeccaStevens in #2969Fixes
ava --versionworks again by @novemberborn in #2961New Contributors
Full Changelog: avajs/ava@v4.0.1...v4.1.0
v4.0.1Compare Source
What's Changed
Full Changelog: avajs/ava@v4.0.0...v4.0.1
v4.0.0: AVA 4Compare Source
We're celebrating the new year with the official AVA 4 release! 🎊
npm install -D avaThe cool new stuff 🆒
Worker threads 🧑💼
By default, test files are now run in worker threads! Huge thanks to @dnlup for landing this.
Test files should run a little quicker, since it's easier to spin up a worker thread than a child process. You can use
--no-worker-threadson the command line, orworkerThreads: falsein your AVA configuration, to fall back to using child processes.Shared workers are no longer experimental 🎊
Shared workers are no longer experimental. This is a powerful feature that loads a program in a worker thread in AVA's main process and then communicate with code running in the test workers. This enables your tests to better utilize shared resources during a test run, as well as providing opportunities to set up these resources before tests start (or clean them up after).
When you use watch mode, shared workers remain loaded across runs.
Improved test selection 🤳
AVA selects test files based on your
package.jsonorava.config.*configuration files. When used on the CLI you can then provide patterns to select a subset of these files.You can now pass a folder and AVA will select the test files contained therein. Or you can provide a specific JavaScript file and AVA will run it even if it wasn’t selected by your configuration.
If AVA finds files based on the configuration, but none of those were selected to the CLI arguments, it now prints a warning.
Better monorepo support 🚝
AVA now looks for
ava.config.*files in parent directories, until it finds a directory with a.gitdirectory (or file). This lets you specify AVA configuration at the top of your monorepo and still run AVA from within each package.New snapshot format 📸
@ninevra has worked tirelessly on landing a new snapshot format. It contains all information necessary to regenerate the report file. This allows for snapshots to be updated even if tests or assertions are skipped.
Previously failing test files run first 🏃
AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @bunysae!
ESM support 🤾
AVA 4 comes with full ES module support. Both ESM and CJS entrypoints are provided so that you can use it no matter how you manage your project.
The
ava.config.jsfile is now treated as CJS or ESM depending on module type configured in thepackage.jsonfile.ava.config.mjsis now supported.If you use JavaScript files with non-standard extensions you can configure AVA to import them.
Note that dependency tracking in watch mode does not yet work with ES modules.
Dedicated macro factory with type inference 🏭
test.macro()returns an object that can be used withtest()and hooks. Thet.contexttype is inherited fromtest. When used with TypeScript this gives much better type inference.Like with AVA 3, regular functions that also have a
titleproperty that is a string-returning function are supported. However the type checking won’t be as good.Source maps 🗺
AVA now uses the source map support that’s built in to Node.js itself. This should give better stack traces. However we’re not sure yet what happens if you load a program that automatically modifies stack traces.
Line number selection (where
npx ava test.js:5runs the test at line 5) now uses source maps and so should work better with TypeScript files.Assertions as type guards 💂
Most assertions now return a boolean indicating whether they passed. If you use AVA with TypeScript, you can use this as a type guard. Thanks @jmarkham828!
(This is not supported for
t.snapshot()and the "throws" assertions.)Breaking changes 💥
AVA 4 requires at least Node.js 12.22, 14.17, 16.4 or 17. Node.js 10 is no longer supported.
If installed globally, AVA will no longer use any locally installed version. Install locally and run with
npx avainstead. When running test files from another project that also has AVA installed, those test files will now fail to run (because they'll try and use that other AVA version).Ecosystem 🏞
@ava/babelhas been removed. We haven’t seen enough contributions to that package to recommend it for AVA 4. We’d be open to reinstating it in the future (just as we’d be open to support any other compilation provider).avajs/typescript@1.1or newer.esmpackage has been removed.Configuration 🗒
ava.config.jsnow follows the module type configured inpackage.json.ava.config.*files may be found that are outside your project directory.Tests and assertions 🥼
test.meta.fileandtest.meta.snapshotDirectoryare now file URL strings.test()andt.try()no longer take an array of test implementations. Use a loop instead.t.throws()andt.throwAsync()assertions can no longer be called with anullvalue for the expectations argument.test.cb()andt.end()have been removed. Use async functions andutil.promisify()instead.t.teardown()now executes in last-in-first-out order.Snapshots 📸
npx ava -uto rebuild your snapshots after upgrading.t.snapshot()no longer works in hooks.t.snapshot()no longer takes an options argument allowing you to customize the snapshot ID.TypeScript 🪛
instanceOfexpectation oft.throws()andt.throwsAsync()assertions must now be anErrorconstructor.test.macro()when declaring macros.unknown.MetareplacesMetaInterface, other types withInterfacesuffixes now use theFnsuffix. There may be some other changes too.4b4b2f6t.throws()andt.throwsAsync()returnundefinedwhen the assertion fails. The type definition now matches this behavior.Other changes 🤓
--configargument may now point to a file that is not alongside thepackage.jsonfile.t.timeout(), AVA itself won’t time out until your test does. Thanks @OhYash!.testand.specextensions from file names, as well astest-prefixes.New Contributors
Full changelog since RC 1: avajs/ava@v4.0.0-rc.1...v4.0.0
Full changelog since AVA 3: avajs/ava@v3.15.0...v4.0.0
v3.15.0: 3.15.0Compare Source
Automatic snapshot file removal
When you stop using snapshots in a test file, the next time you run
ava --update-snapshotswe'll remove the left-over snapshot files. Thanks @ninevra!4f093abTAP improvements
@tymfear has been on a roll improving our TAP reporter.
t.log()output is now compliant with the spec99ab93a. Tests that did not run due to timeouts are now reported98595da.Next-generation configuration
AVA 4 will add full support for ESM configuration files as well as allowing you to have asynchronous factory functions
a2f2614. If you're using Node.js 12 or later you can opt-in to these features in AVA 3 by enabling thenextGenConfigexperiment. Say in anava.config.mjsfile:This also allows you to pass an
.mjsfile using the--configargument.With this experiment enabled, AVA will no longer have special treatment for
ava.config.jsfiles. Instead AVA follows Node.js' behavior, so if you've set"type": "module"you must use ESM, and otherwise you must use CommonJS.You mustn't have an
ava.config.mjsfile next to anava.config.jsorava.config.cjsfile.See avajs/ava@v3.14.0...v3.15.0 for all changes.
v3.14.0: 3.14.0Compare Source
Snapshot ordering
With this release, snapshot files are now ordered based on test declaration, not completion. This makes it easier to compare the human-readable reports to your test file, and also stops the
.snapfrom changing when the reports themselves don't. You'll want to rebuild snapshots after upgrading to this release to isolate any changes. Thanks @ninevra!e66b54cShared workers
We’ve been working on making AVA more extensible. One major step on this path is our new shared worker support: run code in the main process, communicate with test workers and influence execution. Find out more in our shared workers recipe.
See avajs/ava@v3.13.0...v3.14.0 for all changes.
v3.13.0: 3.13.0Compare Source
t.passedcan now be used in tests and teardown functions. Thanks @tymfear!900dc6dnullas the expectation fort.throws()&t.throwsAsync(). You can opt in to this early by enabling thedisableNullExpectationsexperiment. Thanks @JSimoni42!f328a69db5d2c3a3379faSee avajs/ava@v3.12.1...v3.13.0 for all changes.
v3.12.1: 3.12.1Compare Source
Configure how AVA loads test files
Normally, AVA loads all files as CommonJS, except for
mjsfiles and if you've configured"type": "module"in yourpackage.json.As an experiment, you can now configure how AVA loads other file extensions. This is useful if you want to use Node.js' experimental loaders feature. Read more in our documentation. Thank you @macarie for working on this!
5c9dbb9Comparison bugfix
There was a bug in our comparison library which meant that negative-index properties on lists were not compared. This was fixed in a patch release, which will definitely be installed when you install AVA 3.12. Your tests may have been passing, even though they should have been failing. They'll fail now. Snapshots may also be different, causing tests to fail.
All changes
See avajs/ava@v3.11.1...v3.12.1 for all changes.
Thank you @AnthumChris for making sure our ESM example used ESM syntax (
20bc781).v3.12.0Compare Source
v3.11.1: 3.11.1Compare Source
This release fixes corrupted output of the default reporter when test or program code writes to standard out.
5ddc9fdAlso, thanks to @jonathansamines we've taken another step to using AVA to test AVA.
1150991See avajs/ava@v3.11.0...v3.11.1 for all changes.
v3.11.0: 3.11.0Compare Source
New
t.like()assertionThanks to @futpib we now have a
t.like()assertion19c4f35:In the following example, the
mapproperty ofvaluemust be deeply equal to that ofselector. Howevernested.quxis ignored, because it's not inselector.Read more in the
t.like()assertion documentation.This assertion was previously introduced as an experiment.
VSCode 1.47 debugging improvements
You can now debug tests using the new JavaScript Debug Terminal in VSCode 1.47. We've updated our debugging recipe accordingly. Thank you @connor4312 for the documentation updates and your work on VSCode!
bc39bccAll changes
See avajs/ava@v3.10.1...v3.11.0 for all changes.
v3.10.1: 3.10.1Compare Source
It's time for another AVA release 🎉
Restricting when you can update snapshots
When executing a subset of tests, through
--matchor or.only()or.skip(), you can no longer also update snapshots. This prevents you from accidentally deleting snapshots. Thank you @bunysae for putting this together.f72fab4If you are skipping a test that you can't immediately fix, but you still need to update snapshots, use
.failing()instead.Support for message strings in
t.timeout()callsThanks to @jonathansamines you can now provide a message string when using
t.timeout(). This can be useful if your test depends on some other setup that may not have been completed:ca8ea45t.try()does not work in hookst.try()has never worked in hooks, but thanks to @okyantoro it now fails properly instead of crashing.d01db61t.snapshot()does not really work in hooks eithert.snapshot()sort of works in hooks, but we'll be removing this in AVA 4. You can opt in to this behavior by enabling thedisableSnapshotsInHooksexperiment. Again thank you @okyantorod01db61.Fixed TypeScript definition for
t.like()The experimental
t.like()assertion should now work better with TypeScript.All changes
See avajs/ava@v3.9.0...v3.10.1 for all changes.
v3.10.0Compare Source
v3.9.0: 3.9.0Compare Source
New experiments!
Thanks to @futpib we now have an experimental
t.like()assertion19c4f35:In the following example, the
mapproperty ofvaluemust be deeply equal to that ofselector. Howevernested.quxis ignored, because it's not inselector.Read more in the
t.like()assertion documentation and let us know what you think.@yjpa7145 has contributed an experiment to reverse the order in which
t.teardown()functions are run, so that the last registered function is called first952a017. This will be the behavior in AVA 4.To enable both these experiments update your AVA configuration:
package.json:{ "ava": { "nonSemVerExperiments": { "likeAssertion": true, "reverseTeardowns": true } } }ava.config.js:Reporter changes
@Michael55555 has helped us combine our reporter code into a single file
b3866b6. We've also made some other tweaks and improvementsbaaf99a. Let us know if anything seems amiss.Improved diffs
@bunysae made it so that missing or extraneous objects in diffs are printed with extra depth concordancejs/concordance#62.
Farewell Node.js 13
Node.js 13 has reached end-of-life. Per our support statement we have removed it from our test matrix and supported version list.
All changes
See avajs/ava@v3.8.2...v3.9.0 for all changes. Thank you @paulrobertlloyd and @Autre31415 for contributing documentation improvements.
v3.8.2: 3.8.2Compare Source
fd92b4aa5385a4v3.8.1: 3.8.1Compare Source
Node.js 14 support
Great news, this is a feature heavy release!
First off, though, AVA now officially supports Node.js 14. Thank you @zackschuster!
2e7c76bRun tests at specific line numbers
AVA can now run tests at specific line numbers! 🎉
Given the following test file:
test.jsRunning
npx ava test.js:2for would run theunicorntest. In fact you could use any line number between1and3.This feature is only available from the command line. It won't work if you use tools like
ts-node/registeror@babel/register, and it does not currently work with@ava/babeland@ava/typescript. See #2473.Thank you @ulken for your hard work and patience to get this shipped.
1222ce9Test-specific teardown functions
Sometimes tests have side-effects you want to clean up. @ulken has
Configuration
📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.